The AboutBox method displays an About dialog box for the control.

Syntax

AboutBox()

Example

The following examples launch an About dialog box for the control.

Sub ShowAboutBox()
 
    <Object>.AboutBox
 
End Sub

Sub ButtonTool_EventClick()

    Dim This : Set This = ButtonTool
    <Object>.AboutBox
 
End Sub

The AlarmAcknowledge method acknowledges an alarm.

The CanNavNext method specifies whether the next target item (facility or node) can be selected.

The CanNavPrev method specifies whether the previous target item (facility or node) can be selected.

The CanSelNext method returns True if the next item (facility attribute value or node) for the specified level can be selected. Otherwise returns False.

The CanSelPrev method returns True if the previous item (facility attribute value or node) for the specified level can be selected. Otherwise returns False.

The ClearMenu method clears all custom items from the context menu.

Syntax

ClearMenu()

Parameters

• This method takes no parameters.

Return Values

• This method returns no values.

The EnableAllInitialFilterRules method enables or disables all rules and vectors for the initial filter.

The EnableInitialFilterRule method enables or disables a rule or vector of rules by name for the initial filter.

The GetAllTargetFacTags method returns an array of all target facility tags.

The GetDlgCtrlID method returns the numeric resource identifier of the control within TheView.

The GetFacNavBarCustomAttribute method returns the value of a facility navigation bar custom attribute.

The GetGroup method returns the object group to which an object belongs, and returns null if the object does not belong to a group. The GroupID property returns the GroupID. Calling GetGroup is equivalent to calling TheView GetGroupByID and passing the value of the object’s GroupID property, and is provided for convenience.

The GetInitialFilterRuleNames method returns the names of enabled and disabled rules for the initial filter.

The GetSelecedTargetFacTag method returns the facility tag corresponding to the target level combo box selection.

The GetTargetFacilityAttrValues method returns the specified attribute value for all target facilities.

The HistoryAlarms method calls the Alarm History dialog box, which shows the alarm history of an individual alarm, and provides options for showing only particular types of alarm events. See Alarm History for more information.

The HistoryValues method calls the History Values dialog box, which shows all the history records for a given point, including additional information if the history name came from the PNT. See History Records for more information.

The IsSelected method indicates if the tool or control is selected. Can be used with [ContextMenuAutoSelect].

The LayerName method gets the name of the layer on which the object resides.

The Move method moves an object by the specified amount, relative to its current position.

The NavNext method navigates to the next target facility or node. Returns the number of the lowest-level combo box whose selection changed. The EventOnSelChangeLevel event is triggered when NavNext is called.

The NavPrev method navigates to the previous target facility or node. Returns the number of the lowest-level combo box whose selection changed. The EventOnSelChangeLevel event is triggered when NavPrev is called.

The NotifySelChange method forces a complete refresh of the tool and any connected/affected objects. For example, when used with a Group Navigation Bar, NotifySelChange forces a filter change on a Group Navigation Bar to apply to an associated Group Grid object.

The OnUpdate method updates the control to ensure that any property modifications have taken effect.

The OnUpdateResize method updates the control to ensure that any modifications to its boundary have taken effect.

The OnUpdateStyle method updates the control to ensure that any modifications to its style properties have taken effect.

The PersistRunTimeConfig method saves the current control configuration snapshot to the runtime registry key.

The RegisterPointForChangeNotice method registers an unrelated point on a screen that may change its value. Used in conjunction with EventPointChange.

The RestoreDesignTimeConfig method reverts the control to its design-time configuration.

The RestoreRunTimeConfig method reverts the control back to the last runtime configuration.

The RunInitialize method runs the object’s EventInitialize event code.

This method is not used.

The Select method selects the tool or control. "True" to select, "false" to clear. Can be used with [ContextMenuAutoSelect].

The SelNext method selects the next item (facility attribute value or node) for the specified level. If Wrap is True, the selection wraps to the first item, if necessary. The EventOnSelChangeLevel event is triggered when SelNext is called.

The SelPrev method selects the previous item (facility attribute value or node) for the specified level. If Wrap is True, the selection wraps to the last item, if necessary. The EventOnSelChangeLevel event is triggered when SelPrev is called.

The SelectTargetFacility method selects the item in the target combo box that corresponds to the specified facility tag.

The SelFacNavBarCustomAttribute method sets the value of a facility navigation bar custom attribute.

The SetFocus method sets the focus to the control.

The Start method configures the control and starts Run mode.

The Stop method stops Run mode.